/**
 * Copyright (C) 2011 rwoo@gmx.de
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.googlecode.streamflyer.regex.addons.stateful;

import java.util.ArrayList;
import java.util.List;
import java.util.regex.MatchResult;

import com.googlecode.streamflyer.regex.MatchProcessorResult;

/**
 * This {@link TransitionGuard} does not stop the transition but saves the matched token.
 * 
 * @author rwoo
 * 
 */
public class TokenCollector extends TransitionGuard {

    private List<String> foundTokens = new ArrayList<String>();

    public TokenCollector(List<String> foundTokens) {
        super();
        this.foundTokens = foundTokens;
    }

    @Override
    public MatchProcessorResult stopTransition(State nextState, StringBuilder characterBuffer,
            int firstModifiableCharacterInBuffer, MatchResult matchResult) {

        // log the found token
        String foundToken = nextState.getToken().getName() + ":" + matchResult.group();
        foundTokens.add(foundToken);

        // don't stop the transition
        return null;
    }
}
